Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add testing/modifying instructions to README #36

Merged
merged 3 commits into from
Apr 21, 2024

Conversation

hamishwillee
Copy link
Collaborator

@bsmth As discussed in #35 (comment)

This adds links to WABT, the docs on MDN, and to the table for supported features.

README.md Outdated Show resolved Hide resolved
README.md Outdated

Note that some examples use features that are still considered optional.
These are listed in the [supported proposals](https://github.com/WebAssembly/wabt/#supported-proposals) section on the WABT README.md, along with the flags used to invoke them.
For exmaple, to build WASM for the [multi-memory](https://github.com/mdn/webassembly-examples/blob/main/understanding-text-format/multi-memory.wat) example you will need to specify the `--enable-multi-memory` flag as shown:
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bsmth Note this folder structure - everything about understanding the text format is in one folder. But that doc contains heaps of sections, which really could be at their own level.

Anyway, I think in future we should require each example to be in its own sub folder, and at some point move all these too.

@bsmth
Copy link
Member

bsmth commented Apr 19, 2024

This adds links to WABT, the docs on MDN, and to the table for supported features.

This is perfect, thanks a lot for adding!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@bsmth bsmth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super, thank you! Minor fixes as suggestions, but we're good to go!

Co-authored-by: Brian Thomas Smith <brian@smith.berlin>
@hamishwillee hamishwillee merged commit cf86061 into main Apr 21, 2024
@hamishwillee hamishwillee deleted the hamishwillee-patch-1 branch April 21, 2024 23:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants